Ficha técnica

Alcances necesarios

El token para consumir la API Débito Direto Autorizado (DDA) debe generarse usando el Authorization Code.

El alcance openid es obligatorio. Permite consultar el perfil del usuario BTG con acceso a la cuenta.

Alcance	Descripción
brn:btg:empresas:banking:direct-debit	Permite operar la API de DDA

Diccionario de Términos

Términos	Descripción
companyId	CNPJ de la empresa cuyos DDAs están siendo consultados

Eventos de webhook

Los payloads disponibles a continuación representan el contenido del campo data.

Evento	Descripción
authorized-direct-debits.enabled	DDA Habilitado
authorized-direct-debits.disabled	DDA Deshabilitado
authorized-direct-debits.debit-paid	Débito pagado
authorized-direct-debits.debit-added	Débito agregado

authorized-direct-debits.enabled

{
    "accountId": "37297902000141-208-50-003886850",
    "date": "2022-03-02T22:01:55.274Z",
    "creditDebitIndicator": "DEBIT",
    "amount": 30900,
    "currency": "BRL",
    "transactionId": "33449743"
}

authorized-direct-debits.disabled

{
    "directDebitId": "00000000-8bcf-488b-85f9-8b3a041e3eef",
    "owner": {
        "taxId": "30306294000145",
        "name": "NOME EMPRESA"
    },
    "status": "DISABLED"
}

authorized-direct-debits.debit-added

{
    "directDebitId": "00000000-7779-4f25-bec0-ebb3391589be",
    "owner": {
        "taxId": "30306294000145",
        "name": "NOME EMPRESA"
    },
    "status": "ENABLED",
    "debits": [
        {
            "id": "00000000-0000-0000-0000-c35ba9199d96",
            "amount": 24193.61,
            "dueDate": "2023-03-16",
            "expirationDate": "2024-03-16",
            "digitableLine": "20800000000000000000000000000000000000000004800",
            "status": "CREATED",
            "payee": {
                "taxId": "30306294000145",
                "socialName": "Emiss_o Boleto BTG",
                "fantasyName": "Emiss_o Boleto BTG",
                "bank": {
                    "code": "208",
                    "name": "BANCO BTG PACTUAL S.A."
                }
            }
        },
        {
            "id": "00000000-0000-0000-0000-c35ba9199d97",
            "amount": 24193.61,
            "dueDate": "2023-03-16",
            "expirationDate": "2024-03-16",
            "digitableLine": "20800000000000000000000000000000000000000004800",
            "status": "CREATED",
            "payee": {
                "taxId": "30306294000145",
                "socialName": "Emiss_o Boleto BTG",
                "fantasyName": "Emiss_o Boleto BTG",
                "bank": {
                    "code": "208",
                    "name": "BANCO BTG PACTUAL S.A."
                }
            }
        }
    ]
}

authorized-direct-debits.debit-paid

{
    "directDebitId": "00000000-0000-0000-0000-ebb3391589be",
    "owner": {
        "taxId": "00000000000001",
        "name": "NOME EMPRESA"
    },
    "status": "ENABLED",
    "debits": [
        {
            "id": "00000000-0000-0000-0000-c35ba9199d97",
            "amount": 4948.1,
            "dueDate": "0001-01-01",
            "expirationDate": "0001-01-01",
            "digitableLine": "20800000000000000000000000000000000000000004800",
            "status": "PAID",
            "payee": {
                "taxId": "00000000000001",
                "socialName": "SOCIAL NAME",
                "fantasyName": "NAME",
                "bank": {
                    "code": "208",
                    "name": "BANCO BTG PACTUAL S.A."
                }
            }
        }
    ]
}